Esx Settings Clusters Software ApplySpec

Esx Settings Clusters Software ApplySpec
Esx Settings Clusters Software ApplySpec

The Esx Settings Clusters Software ApplySpec schema contains properties that describe the specification to be used for applying the desired software document to a cluster.

This schema was added in vSphere API 7.0.0.0.

JSON Example
{
    "commit": "string",
    "hosts": [
        "string"
    ],
    "accept_eula": false
}
string
commit
Optional

The minimum commit identifier of the desired software document to be used during the POST /esx/settings/clusters/{cluster}/software?action=apply operation.

This property was added in vSphere API 7.0.0.0.

if missing or null or empty the apply operation will use the latest commit to fetch the desired state document.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.esx.settings.commit. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.esx.settings.commit.

array of string
hosts
Optional

The specific hosts within the cluster to be considered during the POST /esx/settings/clusters/{cluster}/software?action=apply operation.

This property was added in vSphere API 7.0.0.0.

if missing or null or empty the POST /esx/settings/clusters/{cluster}/software?action=apply operation will remediate all hosts within the cluster.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: HostSystem. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: HostSystem.

boolean
accept_eula
Optional

Accept the VMware End User License Agreement (EULA) before starting the POST /esx/settings/clusters/{cluster}/software?action=apply operation.

The VMware EULA is available for download at, https://www.vmware.com/download/eula.html

This property was added in vSphere API 7.0.0.0.

if missing or null the POST /esx/settings/clusters/{cluster}/software?action=apply operation could fail due to the EULA not being accepted.